chore: serve the profiling endpoints on their own listener - #358
Open
mennatnaga wants to merge 3 commits into
Open
chore: serve the profiling endpoints on their own listener#358mennatnaga wants to merge 3 commits into
mennatnaga wants to merge 3 commits into
Conversation
mennatnaga
force-pushed
the
menna/debug-listener
branch
from
August 12, 2026 14:14
9d37047 to
7bc5439
Compare
mennatnaga
force-pushed
the
menna/debug-listener
branch
from
August 13, 2026 14:04
7bc5439 to
bea336c
Compare
mennatnaga
force-pushed
the
menna/debug-listener
branch
from
August 14, 2026 23:20
bea336c to
38e7f2e
Compare
tzdybal
force-pushed
the
menna/debug-listener
branch
from
September 1, 2026 10:03
38e7f2e to
dd151fc
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
tzdybal
requested changes
Sep 1, 2026
tzdybal
left a comment
tzdybal
left a comment
Contributor
There was a problem hiding this comment.
I would prefix env variables with SHINZO_ for consistency with other flags and to distinguish from standard Go stdlib flags.
Splitting listen and serve can improve error handling very much - we can stop immediately if listen address is invalid, instead of running with single line of error (not even in log).
Comment on lines
+38
to
+42
| mux.HandleFunc("/debug/pprof/", pprof.Index) | ||
| mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline) | ||
| mux.HandleFunc("/debug/pprof/profile", pprof.Profile) | ||
| mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol) | ||
| mux.HandleFunc("/debug/pprof/trace", pprof.Trace) |
Contributor
There was a problem hiding this comment.
Suggested change
| mux.HandleFunc("/debug/pprof/", pprof.Index) | |
| mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline) | |
| mux.HandleFunc("/debug/pprof/profile", pprof.Profile) | |
| mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol) | |
| mux.HandleFunc("/debug/pprof/trace", pprof.Trace) | |
| mux.HandleFunc("/GET debug/pprof/", pprof.Index) | |
| mux.HandleFunc("GET /debug/pprof/cmdline", pprof.Cmdline) | |
| mux.HandleFunc("GET /debug/pprof/profile", pprof.Profile) | |
| mux.HandleFunc("GET /debug/pprof/symbol", pprof.Symbol) | |
| mux.HandleFunc("GET /debug/pprof/trace", pprof.Trace) |
| // serveDebug starts the debug listener on addr. The listener is what makes the endpoints | ||
| // reachable, so leaving the address unset turns them off without a rebuild. | ||
| func serveDebug(addr string) { | ||
| if os.Getenv("PPROF_BLOCK_MUTEX") != "" { |
Contributor
There was a problem hiding this comment.
Suggested change
| if os.Getenv("PPROF_BLOCK_MUTEX") != "" { | |
| if os.Getenv("SHINZO_PPROF_BLOCK_MUTEX") != "" { |
| } | ||
|
|
||
| go func() { | ||
| fmt.Fprintf(os.Stderr, "debug endpoints listening on %s\n", addr) |
Contributor
There was a problem hiding this comment.
We probably should use logger here.
| } | ||
|
|
||
| func main() { | ||
| if addr := os.Getenv("PPROF_ADDR"); addr != "" { |
Contributor
There was a problem hiding this comment.
Suggested change
| if addr := os.Getenv("PPROF_ADDR"); addr != "" { | |
| if addr := os.Getenv("SHINZO_PPROF_ADDR"); addr != "" { |
| runtime.SetMutexProfileFraction(1) | ||
| } | ||
|
|
||
| srv := &http.Server{ |
Contributor
There was a problem hiding this comment.
If we split listen and serve, we can synchronously notify about invalid pprof server address
mennatnaga
force-pushed
the
menna/debug-listener
branch
from
September 1, 2026 11:11
dd151fc to
fed764b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #357.
The profiling endpoints are moved onto their own mux and listener. Giving a listener a nil handler makes net/http fall back to
http.DefaultServeMux, which carries whatever any linked package registered on it, so the profiling port would answer unrelated endpoints.The listener only starts when
PPROF_ADDRis set, so leaving it unset turns profiling off without a rebuild.It binds wherever
PPROF_ADDRpoints, with no loopback default. In the fleet that protection comes from the docker port mapping rather than from here.